curl -X GET \
\
-H "Accept: application/json" \
"https://api.domainflow.dev/api/v2/campaigns/{campaignId}/domains?limit=56&offset=56&dnsStatus=dnsStatus_example&httpStatus=httpStatus_example&dnsReason=dnsReason_example&httpReason=httpReason_example&minScore=3.4¬Parked=true&hasContact=true&keyword=keyword_example&sort=sort_example&dir=dir_example&warnings=warnings_example&first=56&after=after_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CampaignsApi;
import java.io.File;
import java.util.*;
public class CampaignsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: cookieAuth
ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
cookieAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.setApiKeyPrefix("Token");
// Create an instance of the API class
CampaignsApi apiInstance = new CampaignsApi();
UUID campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID |
Integer limit = 56; // Integer |
Integer offset = 56; // Integer |
String dnsStatus = dnsStatus_example; // String | Filter domains whose authoritative DNS status matches (pending|ok|error|timeout)
String httpStatus = httpStatus_example; // String | Filter domains whose authoritative HTTP status matches (pending|ok|error|timeout)
String dnsReason = dnsReason_example; // String | Filter domains by DNS reason (exact match). Example values: NXDOMAIN, SERVFAIL, REFUSED, NOANSWER, TIMEOUT, ERROR
String httpReason = httpReason_example; // String | Filter domains by HTTP reason (exact match). Example values: TIMEOUT, NOT_FOUND, UPSTREAM_5XX, PROXY_ERROR, TLS_ERROR, SSL_EXPIRED, CONNECTION_RESET, ERROR
Float minScore = 3.4; // Float | Minimum inclusive domain score to include
Boolean notParked = true; // Boolean | Exclude domains detected as parked
Boolean hasContact = true; // Boolean | Only include domains with detected contact signals
String keyword = keyword_example; // String | Require at least one keyword match (any)
String sort = sort_example; // String | Richness-based sort field (defaults to richness_score when omitted)
String dir = dir_example; // String | Sort direction (defaults to desc)
String warnings = warnings_example; // String | Warning filter applied before sorting (has = only domains with penalties; none = only clean domains)
Integer first = 56; // Integer | Page size for cursor pagination (overrides limit when present)
String after = after_example; // String | Cursor token to continue listing after
try {
CampaignDomainsListResponse result = apiInstance.campaignsDomainsList(campaignId, limit, offset, dnsStatus, httpStatus, dnsReason, httpReason, minScore, notParked, hasContact, keyword, sort, dir, warnings, first, after);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CampaignsApi#campaignsDomainsList");
e.printStackTrace();
}
}
}
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final UUID campaignId = new UUID(); // UUID |
final Integer limit = new Integer(); // Integer |
final Integer offset = new Integer(); // Integer |
final String dnsStatus = new String(); // String | Filter domains whose authoritative DNS status matches (pending|ok|error|timeout)
final String httpStatus = new String(); // String | Filter domains whose authoritative HTTP status matches (pending|ok|error|timeout)
final String dnsReason = new String(); // String | Filter domains by DNS reason (exact match). Example values: NXDOMAIN, SERVFAIL, REFUSED, NOANSWER, TIMEOUT, ERROR
final String httpReason = new String(); // String | Filter domains by HTTP reason (exact match). Example values: TIMEOUT, NOT_FOUND, UPSTREAM_5XX, PROXY_ERROR, TLS_ERROR, SSL_EXPIRED, CONNECTION_RESET, ERROR
final Float minScore = new Float(); // Float | Minimum inclusive domain score to include
final Boolean notParked = new Boolean(); // Boolean | Exclude domains detected as parked
final Boolean hasContact = new Boolean(); // Boolean | Only include domains with detected contact signals
final String keyword = new String(); // String | Require at least one keyword match (any)
final String sort = new String(); // String | Richness-based sort field (defaults to richness_score when omitted)
final String dir = new String(); // String | Sort direction (defaults to desc)
final String warnings = new String(); // String | Warning filter applied before sorting (has = only domains with penalties; none = only clean domains)
final Integer first = new Integer(); // Integer | Page size for cursor pagination (overrides limit when present)
final String after = new String(); // String | Cursor token to continue listing after
try {
final result = await api_instance.campaignsDomainsList(campaignId, limit, offset, dnsStatus, httpStatus, dnsReason, httpReason, minScore, notParked, hasContact, keyword, sort, dir, warnings, first, after);
print(result);
} catch (e) {
print('Exception when calling DefaultApi->campaignsDomainsList: $e\n');
}
import org.openapitools.client.api.CampaignsApi;
public class CampaignsApiExample {
public static void main(String[] args) {
CampaignsApi apiInstance = new CampaignsApi();
UUID campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID |
Integer limit = 56; // Integer |
Integer offset = 56; // Integer |
String dnsStatus = dnsStatus_example; // String | Filter domains whose authoritative DNS status matches (pending|ok|error|timeout)
String httpStatus = httpStatus_example; // String | Filter domains whose authoritative HTTP status matches (pending|ok|error|timeout)
String dnsReason = dnsReason_example; // String | Filter domains by DNS reason (exact match). Example values: NXDOMAIN, SERVFAIL, REFUSED, NOANSWER, TIMEOUT, ERROR
String httpReason = httpReason_example; // String | Filter domains by HTTP reason (exact match). Example values: TIMEOUT, NOT_FOUND, UPSTREAM_5XX, PROXY_ERROR, TLS_ERROR, SSL_EXPIRED, CONNECTION_RESET, ERROR
Float minScore = 3.4; // Float | Minimum inclusive domain score to include
Boolean notParked = true; // Boolean | Exclude domains detected as parked
Boolean hasContact = true; // Boolean | Only include domains with detected contact signals
String keyword = keyword_example; // String | Require at least one keyword match (any)
String sort = sort_example; // String | Richness-based sort field (defaults to richness_score when omitted)
String dir = dir_example; // String | Sort direction (defaults to desc)
String warnings = warnings_example; // String | Warning filter applied before sorting (has = only domains with penalties; none = only clean domains)
Integer first = 56; // Integer | Page size for cursor pagination (overrides limit when present)
String after = after_example; // String | Cursor token to continue listing after
try {
CampaignDomainsListResponse result = apiInstance.campaignsDomainsList(campaignId, limit, offset, dnsStatus, httpStatus, dnsReason, httpReason, minScore, notParked, hasContact, keyword, sort, dir, warnings, first, after);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CampaignsApi#campaignsDomainsList");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: cookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"domainflow_session"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"domainflow_session"];
// Create an instance of the API class
CampaignsApi *apiInstance = [[CampaignsApi alloc] init];
UUID *campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // (default to null)
Integer *limit = 56; // (optional) (default to 100)
Integer *offset = 56; // (optional) (default to 0)
String *dnsStatus = dnsStatus_example; // Filter domains whose authoritative DNS status matches (pending|ok|error|timeout) (optional) (default to null)
String *httpStatus = httpStatus_example; // Filter domains whose authoritative HTTP status matches (pending|ok|error|timeout) (optional) (default to null)
String *dnsReason = dnsReason_example; // Filter domains by DNS reason (exact match). Example values: NXDOMAIN, SERVFAIL, REFUSED, NOANSWER, TIMEOUT, ERROR (optional) (default to null)
String *httpReason = httpReason_example; // Filter domains by HTTP reason (exact match). Example values: TIMEOUT, NOT_FOUND, UPSTREAM_5XX, PROXY_ERROR, TLS_ERROR, SSL_EXPIRED, CONNECTION_RESET, ERROR (optional) (default to null)
Float *minScore = 3.4; // Minimum inclusive domain score to include (optional) (default to null)
Boolean *notParked = true; // Exclude domains detected as parked (optional) (default to null)
Boolean *hasContact = true; // Only include domains with detected contact signals (optional) (default to null)
String *keyword = keyword_example; // Require at least one keyword match (any) (optional) (default to null)
String *sort = sort_example; // Richness-based sort field (defaults to richness_score when omitted) (optional) (default to null)
String *dir = dir_example; // Sort direction (defaults to desc) (optional) (default to null)
String *warnings = warnings_example; // Warning filter applied before sorting (has = only domains with penalties; none = only clean domains) (optional) (default to null)
Integer *first = 56; // Page size for cursor pagination (overrides limit when present) (optional) (default to null)
String *after = after_example; // Cursor token to continue listing after (optional) (default to null)
// List generated domains for a campaign
[apiInstance campaignsDomainsListWith:campaignId
limit:limit
offset:offset
dnsStatus:dnsStatus
httpStatus:httpStatus
dnsReason:dnsReason
httpReason:httpReason
minScore:minScore
notParked:notParked
hasContact:hasContact
keyword:keyword
sort:sort
dir:dir
warnings:warnings
first:first
after:after
completionHandler: ^(CampaignDomainsListResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var DomainFlowApi = require('domain_flow_api');
var defaultClient = DomainFlowApi.ApiClient.instance;
// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['domainflow_session'] = "Token";
// Create an instance of the API class
var api = new DomainFlowApi.CampaignsApi()
var campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID}
var opts = {
'limit': 56, // {Integer}
'offset': 56, // {Integer}
'dnsStatus': dnsStatus_example, // {String} Filter domains whose authoritative DNS status matches (pending|ok|error|timeout)
'httpStatus': httpStatus_example, // {String} Filter domains whose authoritative HTTP status matches (pending|ok|error|timeout)
'dnsReason': dnsReason_example, // {String} Filter domains by DNS reason (exact match). Example values: NXDOMAIN, SERVFAIL, REFUSED, NOANSWER, TIMEOUT, ERROR
'httpReason': httpReason_example, // {String} Filter domains by HTTP reason (exact match). Example values: TIMEOUT, NOT_FOUND, UPSTREAM_5XX, PROXY_ERROR, TLS_ERROR, SSL_EXPIRED, CONNECTION_RESET, ERROR
'minScore': 3.4, // {Float} Minimum inclusive domain score to include
'notParked': true, // {Boolean} Exclude domains detected as parked
'hasContact': true, // {Boolean} Only include domains with detected contact signals
'keyword': keyword_example, // {String} Require at least one keyword match (any)
'sort': sort_example, // {String} Richness-based sort field (defaults to richness_score when omitted)
'dir': dir_example, // {String} Sort direction (defaults to desc)
'warnings': warnings_example, // {String} Warning filter applied before sorting (has = only domains with penalties; none = only clean domains)
'first': 56, // {Integer} Page size for cursor pagination (overrides limit when present)
'after': after_example // {String} Cursor token to continue listing after
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.campaignsDomainsList(campaignId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class campaignsDomainsListExample
{
public void main()
{
// Configure API key authorization: cookieAuth
Configuration.Default.ApiKey.Add("domainflow_session", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("domainflow_session", "Bearer");
// Create an instance of the API class
var apiInstance = new CampaignsApi();
var campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | (default to null)
var limit = 56; // Integer | (optional) (default to 100)
var offset = 56; // Integer | (optional) (default to 0)
var dnsStatus = dnsStatus_example; // String | Filter domains whose authoritative DNS status matches (pending|ok|error|timeout) (optional) (default to null)
var httpStatus = httpStatus_example; // String | Filter domains whose authoritative HTTP status matches (pending|ok|error|timeout) (optional) (default to null)
var dnsReason = dnsReason_example; // String | Filter domains by DNS reason (exact match). Example values: NXDOMAIN, SERVFAIL, REFUSED, NOANSWER, TIMEOUT, ERROR (optional) (default to null)
var httpReason = httpReason_example; // String | Filter domains by HTTP reason (exact match). Example values: TIMEOUT, NOT_FOUND, UPSTREAM_5XX, PROXY_ERROR, TLS_ERROR, SSL_EXPIRED, CONNECTION_RESET, ERROR (optional) (default to null)
var minScore = 3.4; // Float | Minimum inclusive domain score to include (optional) (default to null)
var notParked = true; // Boolean | Exclude domains detected as parked (optional) (default to null)
var hasContact = true; // Boolean | Only include domains with detected contact signals (optional) (default to null)
var keyword = keyword_example; // String | Require at least one keyword match (any) (optional) (default to null)
var sort = sort_example; // String | Richness-based sort field (defaults to richness_score when omitted) (optional) (default to null)
var dir = dir_example; // String | Sort direction (defaults to desc) (optional) (default to null)
var warnings = warnings_example; // String | Warning filter applied before sorting (has = only domains with penalties; none = only clean domains) (optional) (default to null)
var first = 56; // Integer | Page size for cursor pagination (overrides limit when present) (optional) (default to null)
var after = after_example; // String | Cursor token to continue listing after (optional) (default to null)
try {
// List generated domains for a campaign
CampaignDomainsListResponse result = apiInstance.campaignsDomainsList(campaignId, limit, offset, dnsStatus, httpStatus, dnsReason, httpReason, minScore, notParked, hasContact, keyword, sort, dir, warnings, first, after);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling CampaignsApi.campaignsDomainsList: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: cookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('domainflow_session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('domainflow_session', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CampaignsApi();
$campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID |
$limit = 56; // Integer |
$offset = 56; // Integer |
$dnsStatus = dnsStatus_example; // String | Filter domains whose authoritative DNS status matches (pending|ok|error|timeout)
$httpStatus = httpStatus_example; // String | Filter domains whose authoritative HTTP status matches (pending|ok|error|timeout)
$dnsReason = dnsReason_example; // String | Filter domains by DNS reason (exact match). Example values: NXDOMAIN, SERVFAIL, REFUSED, NOANSWER, TIMEOUT, ERROR
$httpReason = httpReason_example; // String | Filter domains by HTTP reason (exact match). Example values: TIMEOUT, NOT_FOUND, UPSTREAM_5XX, PROXY_ERROR, TLS_ERROR, SSL_EXPIRED, CONNECTION_RESET, ERROR
$minScore = 3.4; // Float | Minimum inclusive domain score to include
$notParked = true; // Boolean | Exclude domains detected as parked
$hasContact = true; // Boolean | Only include domains with detected contact signals
$keyword = keyword_example; // String | Require at least one keyword match (any)
$sort = sort_example; // String | Richness-based sort field (defaults to richness_score when omitted)
$dir = dir_example; // String | Sort direction (defaults to desc)
$warnings = warnings_example; // String | Warning filter applied before sorting (has = only domains with penalties; none = only clean domains)
$first = 56; // Integer | Page size for cursor pagination (overrides limit when present)
$after = after_example; // String | Cursor token to continue listing after
try {
$result = $api_instance->campaignsDomainsList($campaignId, $limit, $offset, $dnsStatus, $httpStatus, $dnsReason, $httpReason, $minScore, $notParked, $hasContact, $keyword, $sort, $dir, $warnings, $first, $after);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignsApi->campaignsDomainsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CampaignsApi;
# Configure API key authorization: cookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'domainflow_session'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'domainflow_session'} = "Bearer";
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CampaignsApi->new();
my $campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID |
my $limit = 56; # Integer |
my $offset = 56; # Integer |
my $dnsStatus = dnsStatus_example; # String | Filter domains whose authoritative DNS status matches (pending|ok|error|timeout)
my $httpStatus = httpStatus_example; # String | Filter domains whose authoritative HTTP status matches (pending|ok|error|timeout)
my $dnsReason = dnsReason_example; # String | Filter domains by DNS reason (exact match). Example values: NXDOMAIN, SERVFAIL, REFUSED, NOANSWER, TIMEOUT, ERROR
my $httpReason = httpReason_example; # String | Filter domains by HTTP reason (exact match). Example values: TIMEOUT, NOT_FOUND, UPSTREAM_5XX, PROXY_ERROR, TLS_ERROR, SSL_EXPIRED, CONNECTION_RESET, ERROR
my $minScore = 3.4; # Float | Minimum inclusive domain score to include
my $notParked = true; # Boolean | Exclude domains detected as parked
my $hasContact = true; # Boolean | Only include domains with detected contact signals
my $keyword = keyword_example; # String | Require at least one keyword match (any)
my $sort = sort_example; # String | Richness-based sort field (defaults to richness_score when omitted)
my $dir = dir_example; # String | Sort direction (defaults to desc)
my $warnings = warnings_example; # String | Warning filter applied before sorting (has = only domains with penalties; none = only clean domains)
my $first = 56; # Integer | Page size for cursor pagination (overrides limit when present)
my $after = after_example; # String | Cursor token to continue listing after
eval {
my $result = $api_instance->campaignsDomainsList(campaignId => $campaignId, limit => $limit, offset => $offset, dnsStatus => $dnsStatus, httpStatus => $httpStatus, dnsReason => $dnsReason, httpReason => $httpReason, minScore => $minScore, notParked => $notParked, hasContact => $hasContact, keyword => $keyword, sort => $sort, dir => $dir, warnings => $warnings, first => $first, after => $after);
print Dumper($result);
};
if ($@) {
warn "Exception when calling CampaignsApi->campaignsDomainsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: cookieAuth
openapi_client.configuration.api_key['domainflow_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['domainflow_session'] = 'Bearer'
# Create an instance of the API class
api_instance = openapi_client.CampaignsApi()
campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | (default to null)
limit = 56 # Integer | (optional) (default to 100)
offset = 56 # Integer | (optional) (default to 0)
dnsStatus = dnsStatus_example # String | Filter domains whose authoritative DNS status matches (pending|ok|error|timeout) (optional) (default to null)
httpStatus = httpStatus_example # String | Filter domains whose authoritative HTTP status matches (pending|ok|error|timeout) (optional) (default to null)
dnsReason = dnsReason_example # String | Filter domains by DNS reason (exact match). Example values: NXDOMAIN, SERVFAIL, REFUSED, NOANSWER, TIMEOUT, ERROR (optional) (default to null)
httpReason = httpReason_example # String | Filter domains by HTTP reason (exact match). Example values: TIMEOUT, NOT_FOUND, UPSTREAM_5XX, PROXY_ERROR, TLS_ERROR, SSL_EXPIRED, CONNECTION_RESET, ERROR (optional) (default to null)
minScore = 3.4 # Float | Minimum inclusive domain score to include (optional) (default to null)
notParked = true # Boolean | Exclude domains detected as parked (optional) (default to null)
hasContact = true # Boolean | Only include domains with detected contact signals (optional) (default to null)
keyword = keyword_example # String | Require at least one keyword match (any) (optional) (default to null)
sort = sort_example # String | Richness-based sort field (defaults to richness_score when omitted) (optional) (default to null)
dir = dir_example # String | Sort direction (defaults to desc) (optional) (default to null)
warnings = warnings_example # String | Warning filter applied before sorting (has = only domains with penalties; none = only clean domains) (optional) (default to null)
first = 56 # Integer | Page size for cursor pagination (overrides limit when present) (optional) (default to null)
after = after_example # String | Cursor token to continue listing after (optional) (default to null)
try:
# List generated domains for a campaign
api_response = api_instance.campaigns_domains_list(campaignId, limit=limit, offset=offset, dnsStatus=dnsStatus, httpStatus=httpStatus, dnsReason=dnsReason, httpReason=httpReason, minScore=minScore, notParked=notParked, hasContact=hasContact, keyword=keyword, sort=sort, dir=dir, warnings=warnings, first=first, after=after)
pprint(api_response)
except ApiException as e:
print("Exception when calling CampaignsApi->campaignsDomainsList: %s\n" % e)
extern crate CampaignsApi;
pub fn main() {
let campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
let limit = 56; // Integer
let offset = 56; // Integer
let dnsStatus = dnsStatus_example; // String
let httpStatus = httpStatus_example; // String
let dnsReason = dnsReason_example; // String
let httpReason = httpReason_example; // String
let minScore = 3.4; // Float
let notParked = true; // Boolean
let hasContact = true; // Boolean
let keyword = keyword_example; // String
let sort = sort_example; // String
let dir = dir_example; // String
let warnings = warnings_example; // String
let first = 56; // Integer
let after = after_example; // String
let mut context = CampaignsApi::Context::default();
let result = client.campaignsDomainsList(campaignId, limit, offset, dnsStatus, httpStatus, dnsReason, httpReason, minScore, notParked, hasContact, keyword, sort, dir, warnings, first, after, &context).wait();
println!("{:?}", result);
}